﻿// Xshell Configuration Reader Interface
// 
// <copyright file="IXsConfigReader.cs" company="TaskyMedia LLC">
//   Copyright © 2010 TaskyMedia LLC
// </copyright>

namespace Xshell
{
    using System;
    using System.Collections.Generic;

    /// <summary>
    /// Represents a configuration reader for a given source.
    /// </summary>
    public interface IXsConfigReader : IDisposable
    {
        /// <summary>
        /// Sets the metadata cache object.
        /// </summary>
        /// <param name="metadataCache">The metadata cache object.</param>
        void SetMetadataCache(IMetadataCache metadataCache);

        /// <summary>
        /// Reads all task sets from the specified configuration source.
        /// </summary>
        /// <returns>Returns an enumerable collection of <see cref="XsTaskSet"/> instances.</returns>
        IEnumerable<IXsTaskSet> ReadTaskSets();
    }
}
